ASP Advantage 1994 2nd Q2

home *** CD-ROM | disk | FTP | other *** search

/ ASP Advantage 1994 2nd Q2 / The Association of Shareware Professionals - The Official ASP Advantage (2nd Quarter)(1994).bin / files / progming / cl121 / manual.doc < prev next >

Wrap

Text File | 1993-08-17 | 20.1 KB | 842 lines

CODELISTER USER'S MANUAL MALCOLM MCDOWELL 85 Halley St., Nepean Ontario K2J 3R5 Canada (613) 825-8593 . WARRANTY Users of "CodeLister" must accept this disclaimer of warranty: "CodeLister" is supplied as is. The author disclaims all warranties, expressed or implied, including, without limitation, the warranties of merchantability and of fitness for any purpose. The author assumes no liability for damages, direct or consequential, which may result from the use of "CodeLister." USE RESTRICTIONS Malcolm McDowell gives you a non-exclusive license to use the registered version of CodeLister. The program and documentation are copyright by Malcolm McDowell. You may not make copies of this registered version of "CodeLister" without authorization from Malcolm McDowell. A single user license is granted for "CodeLister" for use on only one computer at any time. Site license copies may be used over a network as long as the number of users does not exceed the number of users for the site license. You may not make copies nor distribute the program or documentation to a third party. OMBUDSMAN NOTICE This program is produced by a member of the Association of Software Professionals (ASP). ASP wants to make sure that the shareware principle works for you. If you are unable to resolve a shareware-related problem with an ASP member by contacting the member directly, ASP may be able to help. The ASP Ombudsman can help you resolve a dispute or problem with an ASP member, but does not provide technical support for members' products. Please write to the ASP Ombudsman at 545 Grover Road, Muskegon, MI 49442 or send a CompuServe message via CompuServe Main to ASP Ombudsman 70007,3536. CONTENTS CHAPTER 1 - INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . 1 1.1 System Requirements.. . . . . . . . . . . . . . . . . . . . . . 1 1.2 Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 CHAPTER 2 INSTALLATION. . . . . . . . . . . . . . . . . . . . . . . . . 2 CHAPTER 3 PROJECT FILES . . . . . . . . . . . . . . . . . . . . . . . . 3 3.1 Project File Extension. . . . . . . . . . . . . . . . . . . . . 3 3.2 Creating Project Files. . . . . . . . . . . . . . . . . . . . . 3 CHAPTER 4 RUNNING CODELISTER. . . . . . . . . . . . . . . . . . . . . . 4 4.1 Printing Individual Files.. . . . . . . . . . . . . . . . . . . 4 4.2 Printing Project Files. . . . . . . . . . . . . . . . . . . . . 4 4.3 Definition of CodeLister Display.. . . . . . . . . . . . . . . 5 4.3.1 Printing Files. . . . . . . . . . . . . . . . . . . . . 6 4.3.1.1 Stopping the Printing of Files. . . . . . . . . . 6 CHAPTER 5 SETTING THE CONFIGURATION. . . . . . . . . . . . . . . . . . 7 5.1 Selecting Configuration Parameters. . . . . . . . . . . . . . . 7 CHAPTER 6 DEFINITION OF LISTINGS . . . . . . . . . . . . . . . . . . . . 11 CHAPTER 7 ERROR MESSAGES. . . . . . . . . . . . . . . . . . . . . . . . 12 CHAPTER 8 - SUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . . 13 CHAPTER 1 - INTRODUCTION 1.1 System Requirements. CodeLister is designed to run on DOS 4.00 or higher. A VGA monitor is recommended. The printers supported include, standard graphics printers such as: EPSON ROLAND and laser printers such as: HP LASERJET II HP LASERJET III. 1.2 Features. CodeLister is a package used to support source code development and configuration management. Its features include: ■ Formatted C source code printouts. CodeLister will take individual source files or project files and format them for printing. This prevents lines of text being printed on the perforations or off the page. ■ Each page is identified with a header. The header contains the file name, the date that the file was edited and saved and the page number. This allows you to identify printouts belonging to a given date and configuration. ■ Multiple Pages on a single sheet of paper. If you are using a laser printer, CodeLister can generate listings that have one, two or four pages on each sheet of paper. This is ideal for storing old listings and saving paper. ■ Table of Contents. A Table of Contents lists the functions and the page in the listing where each is defined. This allows you to quickly locate a function in the listing. ■ Statistics The number of lines of code and the size, in bytes, of the ASCII files. CHAPTER 2 INSTALLATION To install CodeLister, perform the following steps: 1) Insert the diskette labelled CODELISTER V1.21 into either disk drive A or B. 2) If you inserted the diskette in drive a:, then at the DOS prompt type: >a: or If you inserted the diskette in drive b:, then at the DOS prompt type: >b: 3) Then type: > INSTALL 4) The installation will create a directory called C:\CLIST and copy the files: CLIST.EXE and CLIST.CFG to that directory. 5) Add the directory to your path name. Use your editor to add the path to autoexec.bat file. This is done by adding: ;c:\clist to the line that has "PATH=" in your autoexec.bat file. Your are now ready to execute CodeLister from any directory on your computer. NOTE: CodeLister will create a configuration file in each directory that you execute it from. CHAPTER 3 PROJECT FILES CodeLister accepts project files as input. A PROJECT FILE is defined as a file containing a list of source code files that are to be formatted and printed. When a project file is used to print your source code, page number 1 starts with the first file and page numbers will continue sequentially until the last source file is printed. The Table of Contents includes all functions in the project file. Statistics printed will include the total number of lines and size, in bytes, for all files defined in the project file. 3.1 Project File Extension. CodeLister will assume that the project file has a .PRJ extension, but any extension can be used provided that it is entered on the command line with the extension such as: clist -p project.fil 3.2 Creating Project Files. To create a project file edit a file that contains all of your C source code. Example project files are shown: main.c function1.c function2.c function3.c function1.h function2.h or main function1 function2 function3 function1.h function2.h Note that some file names exclude the ".c" extension. If the file to be printed, is a ".h" file, make sure the ".h" extension is included in the file name. This is especially important when a file name has both a ".c" and ".h" extension. For example: function1.c and function2.h All files without the extension are assumed to be a .c file. CHAPTER 4 RUNNING CODELISTER The section describes how to run CodeLister. You may print either individual source files, or project files. To run CodeLister one of two command line parameters must be specified. One command line parameter is to tell CodeLister that the file to print is a single "c" source file and the other is to print a project file, which contains a list of "c" files. 4.1 Printing Individual Files. A single source file is printed by typing the following at the DOS prompt: 4.2 Printing Project Files. To distinguish between a source file and a project file, the -p command line entry is typed before the project file name is entered. The project file extension is assumed to be .prj, if no extension is provided. Make sure that you leave a space between the -p and the project file name. A project file is printed by typing the following at the DOS prompt: 4.3 Definition of CodeLister Display. If CodeLister has a valid configuration file, the parameters are displayed, informing you of the type of printout that will be performed. If a configuration file is not found, then CodeLister will automatically prompt you for the information as defined in chapter 5. Otherwise, CodeLister shows the information in the following display: The prompt: CodeLister will print source file: test indicates the file that you requested to be printed. When CodeLister detects a project file the prompt will be: CodeLister will print project file: project Function keys, shown in the display, have the following purpose: F1 - Select Configuration. To modify the configuration, select F1. Refer to chapter 5 for a description of the prompts. F2 - Print. If you select F2, CodeLister prints the source files. F10 - Exit. Function key F10 allows you to exit from CodeLister without printing. 4.3.1 Printing Files. When F2 - Print is selected, CodeLister informs you of the file that is being printed, by displaying the message: Printing file "name" is the name of the source file which is being printed. 4.3.1.1 Stopping the Printing of Files. If during the printing phase you must stop printing, press Esc. The message: Press 'Esc' to stop printing is displayed. To stop printing, press Esc a second time and you will exit CodeLister. If you want to resume printing press any key. CHAPTER 5 SETTING THE CONFIGURATION This chapter describes the initialization of CodeLister configuration parameters. If CodeLister does not have a valid configuration file, or you wish to change the configuration, by selecting F1 - Set Configuration from the main menu, the series of prompts, identified in this chapter are displayed. Valid parameters are listed in each prompt between the brackets, [ and ]. Using the example prompt, Enter value [ 1 or 2 ] ? the valid parameters are [ 1 or 2 ], so you can enter either 1 or 2. If an error is made you will hear a beep and the error message Invalid Entry will be displayed, momentarily, on the lower line of the screen. If this occurs edit the parameter to match one of those in the brackets. The default parameters are displayed after the question mark (?). In the example prompt: Enter value [ 1 or 2 ] ? 1 The value 1 following the ? is the default parameter. The default parameters are obtained from your configuration file. To change a parameter, you can use the DEL or Backspace key and type the appropriate entry. To accept the default parameter, simply press ENTER. 5.1 Selecting Configuration Parameters. This section describes the series of prompts used to choose the configuration. The selections include the printer type, the printer port and the format of the output. These parameters allow CodeLister to communicate with the appropriate printer and provide the output suitable to your needs. Selecting Printer Type.... The first prompt is: Standard graphics printers include: 1) EPSON and ROLAND or Laser printers include: 2) HP LaserJet II and III and compatibles. If you are using a standard graphics printer, enter 1. If you are using a Laser printer enter 2 or 3. The default is 1 or Standard Graphics Printer. Select Character Style... If Compressed style is selected, more characters are printed in a line. Select Page Format... The select page format prompt is only displayed if you selected output to a laser printer. The standard graphics printer selection defaults to single page format. Selection 1, will print a single page on an a full 8 ½ by 11 sheet of paper If you select 2, then two pages will be printed on a single sheet. If you select 3, then four pages will be printed on a sheet of paper. Enter your selection. Select Printer Port... The printer port is the port that the printer is attached to. The possible selections include lpt1, lpt2 or lpt3. Enter the appropriate selection. For a standard DOS configuration your printer is located on lpt1. Select Border... If you wish to have a border around the page enter y. If you select n, the header has a line printed to separate it from the source listing and a line at the bottom of the page. Select Table of Contents... If you wish to have a table of contents printed at the end of the listing enter y. If you select n, no table of contents is printer. If you select Y, then the follwoing prompt will appear: If you wish your Table of Contents to be sort by page, enter 1. If you wish to have the Table of Contents sorted by function name, enter 2. An example of a sort by page is: main()....................................................... 1 DoThis() ..................................................2 ItIsTime() ...............................................2 DoneNow() ..........................................4 The same page sorted by function would appear as: DoneNow() ..........................................4 DoThis() ..................................................2 ItIsTime() ...............................................2 main()....................................................... 1 Select Statistics.... If you wish to have statistics printed enter y. If you select n, no statistics are printed. When the parameters have been initialized, the display, Current Configuration is displayed. CHAPTER 6 DEFINITION OF LISTINGS Each page of the listing contains the following sections: o Header containing: LISTING OF: This is the name of the file whose source code is printed on the page. EDIT DATE: This is the date that the source file was last edited and the source code was saved. Page the number of the page being printed. o Source Code Area This section contains the source code which is printed with or without a boarder. When all of the source code has been printed, the Table of Contents and the Statistics are printed, if they were requested during the initialization of the configuration parameters. An example of the Table of Contents is shown: TABLE OF CONTENTS Function(int a, int b, char *string) ..................... 1 This( void) ...................................................... 2 That (long time) ............................................... 3 On the left side is the name of the function and its parameters. On the right side is the page number that the function is defined on. An example of the Statistics display is shown: Total Size of files (bytes) 3000 Total number of lines 100 The total number of lines indicates the number of non-blank lines found in the source code file. The total size of files, is the number of bytes in the files. CHAPTER 7 ERROR MESSAGES The following is a list of the error messages that appear if CodeLister is unable to perform an action: 1) CL ERROR: Invalid number of parameters. You entered an invalid number of command line parameters when CL was executed. Example command line parameters are: clist file.c or clist file clist -p project.prj or clist -p project 2) CL ERROR: Cannot open source file 'xxxx.x' You enter a source file that could not be located. Ensure that the file name is spelled correctly and that it exists on the specified directory. 3) CL ERROR: Cannot open project file 'xxxx.prj' You enter a project file, that could not be located. Ensure that the project file name is spelled correctly and that it exists on the specified directory. 4) CL ERROR: Unable to create configuration file. CodeLister was unable to create the configuration that is used to store the default parameter for the printer type, printer port. This is probably because the directory that the file is to be written to is full. CodeLister continues with the printing of files, however the parameters must be re-entered the next time is run. 5) CL ERROR: Printer not responding. CodeLister cannot communicate with your printer. Ensure that the printer is either turned on, it is on- line or the correct printer port has been selected in configuration parameters. CHAPTER 8 - SUPPORT Thank you for registering CodeLister. Your registration entitles you to software support for 5 months. You will also be notified of upgrades to CodeLister. Support is available weekdays 4-8pm (eastern time). A telephone answering machine is available. If a message is left, an attempt will be made to answer by telephone. I can also be reached by CompuServe. My ID is 71232,455. If unsuccessful, the response will be by mail. I can be reached my mail : Malcolm D. McDowell 85 Halley St Nepean Ontario K2J 3R5 Canada If you wish to order additional copies of CodeLister, please forward the following information: ---- Registration Form for NON CREDIT CARD ORDERS --- Name: __________________________________________________________ Company: _______________________________________________________ Address: _______________________________________________________ ______________________________________________________ State/Province _______________ ZIP/Postal Code: _____________ Phone: (_____) _______________ Fax: (_____) __________________ Type of Diskette for upgrades 5 1/4 ________ or 3 1/2 ______ Number of copies to register: ________ @ 20.00 per copy ==> ________.____ Shipping and Handling ==> 2.00 ------------------- Total ==> ____________ Printer(s) Used: ________________________________________________________________ --- CREDIT CARD ORDERS ONLY --- You can order with MC, Visa, Amex, or Discover from Public (software) Library by calling 800-2424-PsL or 713-524-6394 or by FAX to 713-524-6398 or by CIS Email to 71355,470. You can also mail credit card orders to PsL at P.O. Box 35705, Houston, Tx 77235-5705. PLEASE REFER TO PRODUCT NUMBER 10771 WHEN ORDERING. THE ABOVE NUMBERS ARE FOR ORDERS ONLY. Any questions about the status of the shipment of the order, refunds, registration options, product details, technical support, volume discounts, dealer pricing, site licenses,etc, must be directed to: Malcolm D. McDowell 85 Halley St., Nepean Ontario K2J 3R5 Canada (613) 825-8593 (4-8 pm weekdays)